home *** CD-ROM | disk | FTP | other *** search
/ Aminet 6 / Aminet 6 - June 1995.iso / Aminet / comm / cnet / bbsmon.lha / whmon.doc < prev    next >
Encoding:
Text File  |  1995-04-04  |  13.8 KB  |  318 lines
  1.  
  2. ---------------------------------------------------------------------------
  3. ===========================================================================
  4.                       BBSMonitor 1.0b - Documentation
  5. ===========================================================================
  6. ---------------------------------------------------------------------------
  7.  
  8. Note: Sorry if these docs are kinda flaky.  It is 4am in the morning, and
  9.       I've been up for about 20 hours fixing the few last bugs, so my mind
  10.       is just about gone, it may look strange if I cut and forgot to
  11.       paste something back.  (I'm too tired/lazy right now to re-read
  12.       through it, and with my luck I'll probably miss any errors anyway :])
  13.  
  14.  
  15. Description
  16. ~~~~~~~~~~~
  17. This program allows you to monitor most of the activities of the users on
  18. your BBS without repeatedly hitting WH or WH;WH;WH;WH;WH;WH over and over
  19. again.  It has been optimized to only update changes, instead of repeatedly
  20. redoing the same command over and over again, as well as provides MUCH more
  21. information that I feel is more informative than the standard WH
  22. information.  (Who Banners were left out for space considerations, not to
  23. mention they dont change often, so a monitor of the banners is really
  24. useless).
  25.  
  26. A short version of the monitor is included, which is like a replacement for
  27. the C-Net WH command (although I recommend not replacing it, but calling this
  28. utility something like WW or something).  This is so that you don't have to
  29. go into the bbs monitor just to look up any of the informative statistics that
  30. are provided by the bbsmonitor.  The output is almost exactly the same as the
  31. monitor, except that the header and personal statistics at the bottom are not
  32. displayed.
  33.  
  34. ===========================================================================
  35.  
  36. Disclaimer (I hate it when people put the disclaimer before the description)
  37. ~~~~~~~~~~
  38. I take no responsibilty for the actions of this program, use it at your own
  39. risk.  This means, for example, if you or one of your users were to use
  40. this program, while at the same time, a planetary alignment in a nearby
  41. solar system signals your Amiga to pray to it's idol, the Guru, ceasing all
  42. functions in the middle of a hard disk write, which startles you, the SysOp,
  43. making you suddenly fall back in your chair, knocking a plugged-in toaster
  44. into a pool of attractive members of the opposite sex, causing the pennies
  45. you replaced for fuses to suddenly become very hot, then blowing up a nearby
  46. electrical substation over a well known fault, causing half of California
  47. to fall into the ocean, then I am not to blame...
  48.  
  49. ===========================================================================
  50.  
  51. Installation
  52. ~~~~~~~~~~~~
  53.  
  54.  
  55.  
  56. Edit S:BBSMon.config with these settings (optional, but recommended)
  57.    Line 1: The first port to monitor (example:   0)  }-.
  58.    Line 2: The last port to monitor  (example:  10)  }-`-- will do ports 0-10
  59.    Line 3: The text to be shown in the "Where" label
  60.  
  61.    It's Just an arexx program (compiled) so, treat it as such, if you are not
  62.    sure about how to do this read on:
  63.  
  64. Add these 2 lines to your bbsmenu under Available Everywhere:
  65.  
  66.    MONitor | #0cnet:pfiles/whmon/whmon.rexx}               (the monitor)}
  67.    WW      | #0cnet:pfiles/whmon/wh.rexx}                  (the quick who)}
  68.  
  69.    `--.---'                                                `--------.-------'
  70.       `------- Change to whatever command you want      .-----------'
  71.                                                         `-- Dont add this! :)
  72.  
  73. Reload BBSText/Menu by selecting the option on the Cnet Control Panel's
  74.    First menu.
  75.  
  76.    Or add it to the Pfiles with the A command while in the pfiles area.  Add
  77.    it as an Arexx program (I know it looks like object code), and everything
  78.    should be fine.
  79.  
  80. ===========================================================================
  81.  
  82. The Screen (also explained by pressing H while running the program)
  83. ~~~~~~~~~~
  84. Statistics that are listed, but not monitored:
  85. Port Number
  86.     Cyan   - Using Text set 0
  87.     Yellow - Using Text set 1
  88. Handle
  89.     Red  - Female user
  90.    Blue - Male user
  91. Baud Rate   Description                         Set
  92.    Red    - Less than 2400 baud                 [0-2400)
  93.    Yellow - 2400 up to but not 9600 baud        [2400-9600)
  94.     Green  - 9600 up to and including 14400 baud [9600-14400]
  95.     Cyan   - More than 14400 baud                (14400-infinity)
  96.  
  97. Statistics that are monitored (updated):
  98. BBS Text set
  99.     - Represented by color of port number
  100.     - Only supports 2 text sets (currently)
  101. OLM Waiting
  102.    - * next to the port number means there is an olm waiting
  103. Where
  104.     - Just like the where field listed in the standard C-Net WH
  105. Hidden Flags
  106.     H - Is hiding from you
  107.    * - Is hiding from everyone on the bbs
  108.    U - You are hiding from this user
  109. Muffle Flags
  110.    M - Is muffling you
  111.    * - Is muffling everyone on the bbs
  112.    U - You are muffling this user
  113. Chat Flags
  114.    C - Requested a chat from you
  115.    U - You requested a chat from this user
  116. Time Since Login
  117.     - Time in minutes this user has been online this call
  118. Idle Time
  119.    - Time in minutes this user has been idle
  120.    Green  - Idle less than 5 minutes  [0-5)  mins
  121.    Yellow - Idle 5-10 minutes         [5-10) mins
  122.     Red    - Idle more than 10 minutes [10-infinity) mins
  123. Time Left
  124.     - How much time the user has remaining (quite handy!)
  125.     Green  - More than 30 minutes remaining (infinity-30]
  126.     Yellow - 30-10 minutes remaining        (30-10]
  127.    Red    - Less than 10 minutes remaining (10-0]
  128.    - This is very useful for sysops who like to give time, so that they can
  129.      do a user listing and _quickly_ see who is low on time, just by the
  130.      color of their time left.
  131. Last command/program
  132.    - Shows the last command executed by the user
  133.    - If the last command has a Where of its own, it will be displayed here
  134.      (sorry this is a shortcut method, I know the 'Where' is already listed,
  135.      and it is redundant to show where they are twice, but the getuser info
  136.      comes in this format for the easily accessable information.  Future
  137.      versions may include the real last command, ignoring where information)
  138.  
  139. The Author
  140. ~~~~~~~~~~
  141. I am currently (March 1995) a college student getting a degree in Computer
  142. Engineering.  I frequently hang out on IRC with the nick Josef (yeah,
  143. original name eh?), and enjoy writing arexx utilities, and answering
  144. questions about the Amiga computer for people.  If you have any suggestions
  145. for programs for Cnet or any other program, I would be glad to give it a
  146. try, provided I have some free time from classes :)  If you have any
  147. questions or comments, I would gladly appreciate them by mailing me email,
  148. or snail-mail.  Criticisims are also helpful, as I always welcome
  149. suggestions on how to improve my programs.
  150.  
  151. Josef Faulkner (panther@gate.net)
  152. 5253 N Old Dixie Hwy
  153. Fort Pierce, FL  34946-7301
  154. USA
  155.  
  156. Known Bugs
  157. ~~~~~~~~~~
  158. -    This program will only work with up to 12 ports correctly on a 24-line
  159.     terminal, so it may be necessary to redraw the screen with Ctrl-L if you
  160.     are using between 13 and 18 ports.  It will not work at all over 18
  161.     ports :(  I plan to make some modifications so that future versions will
  162.     allow you to scroll up and down through the list with the arrow buttons
  163.     if there are more ports than the height of your screen allows.
  164.  
  165. History
  166. ~~~~~~~
  167. I always hated history, so I will skip this... :)
  168.  
  169.  
  170. Shareware
  171. ~~~~~~~~~
  172. Ok, It's kinda shareware-giftware.  Send me a gift, or if you are not very
  173. creative $5 will do, or for those of you who hate to deal with snail mail,
  174. send me something nice (see below) via uuencoded mail.  Also I am willing to trade
  175. registrations for a program you may have written.
  176.  
  177. Upon registration, you will recieve a keyfile by e-mail, or on disk by
  178. snail-mail if you do not have internet access.  However, since I must pay
  179. for the disk and postage for snail mail, I do request that you send either:
  180. 1) a disk (with any of the below files) and a return postage paid envelope
  181. or (if you arent all that creative (I know I am not (is this comment getting deep?)))
  182. 2) the standard $5 registration (I will send you a disk and pay postage for this)
  183.  
  184. This program has not been disabled in any way.  The only differences
  185. between the shareware version and the registered version is the removal of
  186. the annoying red message that flashes across the top of the screen every
  187. 10 seconds, and a thank-you message in the "About" command, instead of a
  188. nagging message.  I do not believe in disabling a program, except in future
  189. versions if you do not get any or very few registrations.  I have
  190. registered quite a few programs, and I can tell you that it is a nice
  191. feeling to know that you are helping to support the Amiga, especially in
  192. its current stages of transition, by supporting the programmers who write
  193. software for the Amiga.
  194.  
  195. Any or all :) of the following will usually get me to send you a registered
  196. version.
  197. E-Mail things (files) you can send:
  198. -    A few _NICE_ mods (none of that techno stuff, especially mods that are
  199.    derived from real songs, or make for a peaceful background sound)
  200. -    A nice utility for cnet that isnt already on Aminet
  201. -  Hacks (legal) for the Amiga or other electrical devices (engineering
  202.     stuff)
  203. -  TI-85 Games/Utilities (that arent already on internic.net)
  204. -  Any arexx programs you have written that serve a useful purpose
  205. -  A registered version of a program written by you
  206. -  Something science/math related that is new&interesting
  207.  
  208. Snail-Mail things (necessary if you (or a friend) dont have an internet address):
  209. -    $5 
  210. -  Floppy Disk with any of the above things plus return postage
  211.  
  212. Registration Form:
  213.  
  214. Example: 
  215.  _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ 
  216. |F|i|l|l| |O|u|t| |L|i|k|e| |t|h|i|s|
  217. |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|    Put an x over the o to indicate a
  218.  x o o o o x o o o x o o o o o o o o <-- capital letter in the box.
  219.                                          (only necessary if handwritten)
  220. --8<-8<-8<-C-u-t---H-e-r-e-------------------------------------------------
  221.  
  222. .-----------------------.                          .----------------------.
  223. |\\\\\\\\\\\\\\\\\\\\\\\|--------------------------|//////////////////////|
  224. |\\\\\\\\\\\\\\\\\\\\\\\| BBS Monitor Registration |//////////////////////|
  225. |\\\\\\\\\\\\\\\\\\\\\\\|--------------------------|//////////////////////|
  226. `-----------------------'                          `----------------------'
  227.  
  228. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  229.  
  230. BBS Name (must be exactly the way you enter it in Cnet Config!)
  231.  _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
  232. | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
  233. |_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|_|
  234.  o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o
  235.  
  236. Email: ____________@_______________________________ (for return reply)
  237.  
  238. Check (x) if no email: o
  239.  
  240. If no email, fill out return mailing address in this area:
  241.  
  242.             ___________________________________________
  243.  
  244.             ___________________________________________
  245.  
  246.             ___________________________________________
  247.  
  248.             ___________________________________________
  249.             Be sure to include compensation for return shipping
  250.             if receiving a reply through snail-mail (see above)
  251.  
  252. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  253.  
  254. Other Information (record purposes):
  255.  
  256. Your Name:  ____________ ____________________  Handle: _________________
  257.  
  258. BBS Number: ___________________ Lines: _____ System: A___00/680__0/___Mhz
  259.  
  260. IP Address (if one): _____._____._____._____ 
  261.  
  262. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  263.  
  264. Notes  _________________________________________________________________
  265. and/or 
  266. Bugs   _________________________________________________________________
  267.  
  268.        _________________________________________________________________
  269.  
  270.        _________________________________________________________________
  271.  
  272.        _________________________________________________________________
  273.  
  274.        _________________________________________________________________
  275.  
  276.        _________________________________________________________________
  277.  
  278.        _________________________________________________________________
  279.  
  280.        _________________________________________________________________
  281.  
  282. --8<-8<-8<-C-u-t---H-e-r-e-------------------------------------------------
  283. ===========================================================================
  284.  
  285. Extra Stuff (Stuff I add after I originally wrote the docs and im too lazy to
  286. ~~~~~~~~~~~  incorporate it into whats already here)
  287.  
  288. 1.0a - Local BBS testing
  289. ~~~~
  290. - Too many fixes and stuff to list :)
  291.  
  292. 1.0b - First Public Release  (please report bugs!)
  293. ~~~~
  294. Now attempts to figure out your screen height via the getuser variable.  It will
  295. only redraw the screen when an OLM (assume 5 line olm) will cause the screen to
  296. scroll up.  I hope in future versions to build in OLM support directly, maybe
  297. even open the OLM in a window on the screen with an [ OK ] button :)
  298.  
  299. Added the ability to scroll through the listing with '+' (or '=') and '-'
  300. so that users with only 24 lines can scroll through the list on a 18+ line BBS
  301. Right now this is just a hack-on, I hope to rewrite the code so that this is
  302. more efficient for Version 2.0
  303.  
  304. Arrow keys will work in place of + and - now...
  305.  
  306. Now uses ansi L and M codes to scroll through the list without redrawing
  307. all the ports (M will cut out a line, while L inserts one)...
  308.  
  309. # in the title bar will now display the first digit of the first port, from that
  310. you can find out what the remaining ports are.  If you encounter a 0, it will be
  311. next value of 10.  I did not mention in the docs above that the ports are only
  312. listed with one numeral (port mod 10), to save space.  This feature will now
  313. allow you to find out what any port number is on the screen.
  314.  
  315. Added ability to expand and shrink monitor window using arrow left and arrow right
  316. keys.  Use [ and ] in place of arrow keys if you dont have arrow keys...
  317.  
  318.